Skip to content

Actions self-hosted runners - Fix incorrect installation instruction#16600

Closed
rbuchberger wants to merge 1 commit intogithub:mainfrom
rbuchberger:patch-2
Closed

Actions self-hosted runners - Fix incorrect installation instruction#16600
rbuchberger wants to merge 1 commit intogithub:mainfrom
rbuchberger:patch-2

Conversation

@rbuchberger
Copy link
Copy Markdown

@rbuchberger rbuchberger commented Mar 28, 2022 •
edited
Loading

Why:

The instructions for installing a self-hosted actions runner on linux as another user are incorrect, and if followed fail with an error. This change corrects those instructions.

svc.sh simply takes the second argument; there's no --user flag. If provided, the script tries to find a user literally named --user and fails with "Group not available".

There's no associated issue.

What's being changed:

Remove --user flag from ./svc.sh install <USER> instructions, which results in desired behavior.

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@rbuchberger
Fix incorrect Linux install-as-user instructions
cb46a2d 
Regarding svc.sh - https://github.com/actions/runner/blob/408d6c579c36f0eb318acfdafdcbafc872696501/src/Misc/layoutbin/systemd.svc.sh.template#L65 

It just takes the second argument; there's no `--user` flag. If provided, the script tries to find a user literally named `--user` and fails with "Group not available".
@welcome
Copy link
Copy Markdown

welcome Bot commented Mar 28, 2022

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Mar 28, 2022
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 28, 2022

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md Modified Original

@rbuchberger rbuchberger changed the title Fix incorrect Linux install-as-user instructions Actions Self-hosted runners - Fix incorrect install-as-user instructions Mar 28, 2022
@rbuchberger rbuchberger changed the title Actions Self-hosted runners - Fix incorrect install-as-user instructions Actions self-hosted runners - Fix incorrect installation instruction Mar 28, 2022
@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert and removed triage Do not begin working on this issue until triaged by the team labels Mar 28, 2022
@ramyaparimi
Copy link
Copy Markdown
Contributor

ramyaparimi commented Mar 28, 2022

@rbuchberger
Thanks so much for opening a PR! I'll get this triaged for review ⚡

@ethomson
Copy link
Copy Markdown
Contributor

ethomson commented Apr 6, 2022

Thanks for this! It looks like the svc.sh only accepts a user argument when adding a systemd service - it will silently fail on macOS and, worse, there's no svc.sh on Windows at all.

I think that your change is 💯 but it would be great if you could pull it up into the linux conditional (so, line https://github.com/github/docs/pull/16600/files#diff-9880f13992e379bdd4479c01ab92296f51c3923c521fcab04d56c85f96481adfL67 if I'm looking at the file correctly.)

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 13, 2022

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions Bot added the SME stale The request for an SME has staled label Apr 13, 2022
@ramyaparimi
Copy link
Copy Markdown
Contributor

ramyaparimi commented Apr 14, 2022

@rbuchberger I am checking to see if you are still working on this PR 💖 .

@ramyaparimi ramyaparimi added SME reviewed An SME has reviewed this issue/PR and removed SME stale The request for an SME has staled needs SME This proposal needs review from a subject matter expert labels Apr 14, 2022
@rbuchberger
Copy link
Copy Markdown
Author

rbuchberger commented Apr 14, 2022

Hi @ramyaparimi - sorry for the long delay! I was on vacation and only returned today. I'll have a look.

@ramyaparimi
Copy link
Copy Markdown
Contributor

ramyaparimi commented Apr 14, 2022

@rbuchberger No worries at all!! I hope you had a good vacation! Thank you for letting me know. I wanted make sure the stale bot didn't hit and close the PR 🙈

@janiceilene janiceilene added more-information-needed More information is needed to complete review and removed waiting for review Issue/PR is waiting for a writer's review labels May 23, 2022
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 30, 2022

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

@github-actions github-actions Bot added the stale There is no recent activity on this issue or pull request label May 30, 2022
@github-actions github-actions Bot closed this Jun 2, 2022
Deloww
Deloww reviewed Jun 4, 2022
View reviewed changes
Copy link
Copy Markdown

@Deloww Deloww left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md[content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md](content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@Deloww Deloww Deloww left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review SME reviewed An SME has reviewed this issue/PR stale There is no recent activity on this issue or pull request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@rbuchberger @ramyaparimi @ethomson @Deloww @janiceilene